'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH omod.conf 5 2009-02-27 "File Format" ""
.SH NAME
omod.conf \- configuration for omod and related utilities
.SH SYNOPSIS
'nh
.fi
.ad l
/etc/omod.conf
.ad b
'hy
.SH DESCRIPTION
The \*(T<\fIomod.conf\fR\*(T> file contains configuration information for the
\fBomod\fR(8) daemon, as well as the 
.PP
The general format of \*(T<\fIomod.conf\fR\*(T> is as follows:
.PP
.nf
\*(T<

<global configuration options>
<poll server configuration>
<message server configuration>
<command server configuration>
<proxy configuration>

            \*(T>
.fi
.SH "GLOBAL CONFIGURATION OPTIONS"
.TP 
\*(T<\fBthread_pool_size\fR\*(T>
Defines how many threads are created for the thread pool.
All requests are assigned to an available thread to be handled,
and then the thread is returned to the pool when done.
.TP 
\*(T<\fBpoll_regex\fR\*(T>
Defines a regular expression that is checked against incoming web
requests to the poll server. If matched, then the request is treated as
a client poll (ping), and the request is held open. If it doesn't match,
then its available to be checked against all defined proxies.
.TP 
\*(T<\fBsession_id\fR\*(T>
The session ID for each web client, and found in poll requests.
The server will also passively store sessions as the pass from proxy
servers back to web clients. The server will only allow poll requests
from previously discovered session IDs.
.TP 
\*(T<\fBtimeout\fR\*(T>
The amount of time a poll request (ping) will stay open, waiting
for an asynchronous message, before the server will time out the poll
request and send back and empty response (pong).
.SH "COMMON SERVER OPTIONS"
.TP 
\*(T<\fBsocket_type\fR\*(T>
The type of socket to create. Must be one of inet or unix.
.TP 
\*(T<\fBhost\fR\*(T>
The hostname or IP address to listen on. It's only valid if
\*(T<\fBsocket_type\fR\*(T> is inet. If \*(T<\fBsocket_type
\fR\*(T>is inet, but host is not specified, then a socket will be created
for all host IPs. The socket will listen on both IPv4 and IPv6 addresses
where appropriate, unless restricted by the command line options 
\*(T<\fB\-4\fR\*(T> and \*(T<\fB\-6\fR\*(T>. See \fBomod\fR(8).
.TP 
\*(T<\fBport\fR\*(T>
This option is required if \*(T<\fBsocket_type\fR\*(T> is set to 
inet. Specifies the port to listen on.
.TP 
\*(T<\fBfile\fR\*(T>
This option is required if \*(T<\fBsocket_type\fR\*(T> is set to
unix. Specifies the filename of the socket to create.
.TP 
\*(T<\fBssl\fR\*(T>
Specified whether or not Secure Sockets Layer (SSL) is enabled
for the server.
.TP 
\*(T<\fBssl_cert\fR\*(T>
The file containing the certificate.
.TP 
\*(T<\fBssl_key\fR\*(T>
The file containing the certificate key.
.TP 
\*(T<\fBproxy_regex\fR\*(T>
Only valid in a proxy configuration block, otherwise its ignored.
Defines a regular expression that is checked against incoming
requests to the poll server. If matched, then the request is
proxied to the specified host and port.
.TP 
\*(T<\fBrewrite_host\fR\*(T>
Only valid in a proxy configuration block, otherwise its ignored.
If set to true, will rewrite the host header using the value specified
in host.
.SH FILES
The default configuration file is located at \*(T<\fI/usr/local/etc/omod.conf\fR\*(T>, but
can be changed at compile time or run time.
.SH MAINTAINER
\fBomod\fR and this associated documentation is maintained by
Dan White
<\*(T<whitehse@gmail.com\*(T>>.
.SH COPYRIGHT
Copyright 2009 Dan White. \fBomod\fR is free software: you can
redistribute it and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
\fBomod\fR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with Foobar. If not, see http://www.gnu.org/licenses/.
.SH BUGS
.SH HISTORY
Version 0.1 released on xxxx-xx-xx. Initial release.
.SH "SEE ALSO"
\fBomod\fR(8), \fBomoctl\fR(8).
